home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / olrdrs / bwdev201.zip / BWSTRUCT.DOC < prev    next >
Text File  |  1994-01-18  |  52KB  |  1,044 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                        The Blue Wave Offline Mail System
  13.                           Mail Packet File Structures
  14.                                 Revision Level 2
  15.  
  16.                  Copyright 1990-1994 by Cutting Edge Computing
  17.                               All Rights Reserved
  18.  
  19.                            Created by George Hatchew
  20.  
  21.                Documentation by Martin Pollard and George Hatchew
  22.                         Revision 2.01 - January 18, 1994
  23.  
  24.  
  25.  
  26.                               ===================
  27.                                TABLE OF CONTENTS
  28.                               ===================
  29.  
  30.      Introduction ...................................................... 3
  31.      Filename Conventions .............................................. 3
  32.      Files in Blue Wave Packets ........................................ 4
  33.      Byte Ordering in File Structures .................................. 6
  34.      Using the File Structures ......................................... 6
  35.      Unused and Reserved Structure Fields .............................. 7
  36.      The *.INF File (INF_HEADER & INF_AREA_INFO) ....................... 8
  37.      The *.MIX File (MIX_REC) .......................................... 10
  38.      The *.FTI File (FTI_REC) .......................................... 11
  39.      The *.DAT File .................................................... 12
  40.      The *.XTI File (XTI_REC) .......................................... 12
  41.      The *.UPL File (UPL_HEADER & UPL_REC) ............................. 12
  42.      The *.UPI (UPI_REC) and *.NET (NET_REC) Files ..................... 14
  43.      The *.REQ File (REQ_REC) .......................................... 14
  44.      The *.PDQ File (PDQ_HEADER & PDQ_REC) ............................. 14
  45.      Appendix A - How to Create a Blue Wave Mail Packet ................ 15
  46.      Appendix B - How to Create a Blue Wave Reply Packet ............... 16
  47.      Appendix C - The Blue Wave Structures and Turbo Pascal ............ 16
  48.      Appendix D - Serial Numbers in Mail and Reply Packets ............. 18
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.                           ============================
  58.                            COPYRIGHT AND RESTRICTIONS
  59.                           ============================
  60.  
  61.      The  Blue Wave packet structures were created by George  Hatchew,  and
  62.      are the copyrighted property of Cutting Edge Computing.  Permission is
  63.      granted  for third parties to use these structures in their  own  pro-
  64.      grams,  without  any  royalties or licenses  required.   Cutting  Edge
  65.      Computing reserves the right to make any changes to these  structures,
  66.      at  any  time.  As such, third parties are requested not to  make  any
  67.      unauthorized changes to these structures, as Cutting Edge Computing is
  68.      not  bound  to follow these changes.  Any proposed changes  should  be
  69.      brought to the attention of Cutting Edge Computing, where they may  be
  70.      included in future revisions of the structures.
  71.  
  72.      Authors  that  use these structures are allowed to  claim  that  their
  73.      programs are "Blue Wave compatible".  However, to avoid confusion  and
  74.      complications, authors are NOT allowed to use "Blue Wave" as any  part
  75.      of the name of their programs (as "Blue Wave" is a product line  from,
  76.      as well as a trademark of, Cutting Edge Computing).
  77.  
  78.  
  79.  
  80.                               ===================
  81.                                TRADEMARK NOTICES
  82.                               ===================
  83.  
  84.      The  following are products, trademarks, or registered  trademarks  of
  85.      the following individuals and/or companies:
  86.  
  87.           ARC - System Enhancement Associates
  88.           Blue Wave - George Hatchew and Cutting Edge Computing
  89.           FidoNet - Tom Jennings and Fido Software
  90.           MegaReader - Kip Compton
  91.           MS-DOS - Microsoft Corp.
  92.           PKZIP - PKWARE Inc.
  93.           QWK - Mark "Sparky" Herring
  94.           Silver Xpress - Hector Santos and Santronics Software
  95.           Turbo Pascal, Borland Pascal - Borland International
  96.           XRS - Michael Y. Ratledge
  97.  
  98.      Any omissions from this list are purely unintentional.
  99.             Blue Wave Mail Packet File Structures - Revision Level 2
  100.  
  101.  
  102.      INTRODUCTION
  103.      ============
  104.  
  105.      The world of offline mail has virtually exploded since the late 1980s,
  106.      due mostly to the ever-increasing interest in electronic mail networks
  107.      (such  as FidoNet and the Internet).  As the flow of  mail  increased,
  108.      more and more users became aware of the benefits of downloading  mail,
  109.      reading it offline, and uploading replies at a later date, thus  maxi-
  110.      mizing efficiency and minimizing the time spent online.
  111.  
  112.      Several  competing formats for storage of offline mail have come  into
  113.      existence during this period, with the minimalist QWK format  emerging
  114.      as the dominant one due to its open specifications.  (The  MegaReader,
  115.      Silver Xpress, and XRS, formats also exist, but never really  achieved
  116.      "critical mass" due to the proprietary nature of their file  formats.)
  117.      QWK  enjoys widespread popularity, but its technical limitations  make
  118.      it less than suitable for handling the wide variety of electronic mail
  119.      that currently exists (and which will appear in the coming years).
  120.  
  121.      The  Blue Wave format was designed as a superior method  of  providing
  122.      offline  mail  capabilities, particularly for networks  based  on  the
  123.      FidoNet  standard (which means full support for FidoNet-style  private
  124.      mail,  or  NetMail).  Its design is simple enough that  virtually  any
  125.      programmer can create a Blue Wave-compatible product in a short amount
  126.      of  time,  yet flexible enough to provide plenty of  room  for  future
  127.      needs (such as FAX capabilities).  It also has basic support for  non-
  128.      FidoNet  style  mail, such as that required by Internet  mail,  Usenet
  129.      newsgroups, and QWK-based network mail.
  130.  
  131.      NOTE THAT THIS IS A REFERENCE DOCUMENT, NOT A PROGRAMMING TUTORIAL.  A
  132.      tutorial  on programming is beyond the scope of this document.   Thus,
  133.      we do not recommend the use of these structures by the novice.
  134.  
  135.  
  136.      FILENAME CONVENTIONS
  137.      ====================
  138.  
  139.      The Blue Wave format was originally designed for the Blue Wave  series
  140.      of  offline mail readers and doors running on an  Intel-compatible  PC
  141.      using MS-DOS (or a DOS-compatible operating system).  This means  that
  142.      filenames  are limited to the DOS standard "8.3" format (up  to  eight
  143.      characters, optionally followed by a period and a one to three charac-
  144.      ter  extension, with no distinction made between upper and lower  case
  145.      letters).   For  maximum  compatibility  across  different  platforms,
  146.      programs utilizing the Blue Wave format should limit filenames to  the
  147.      DOS format as well.
  148.  
  149.      Additionally,  DOS allows for some non-alphanumeric characters  to  be
  150.      used  in  filenames.  These characters, while suitable  for  DOS,  may
  151.      cause  problems on non-DOS platforms.  Therefore, it would be wise  to
  152.      restrict  the allowable characters in filenames to  uppercase  letters
  153.      ("A" to "Z") and digits ("0" to "9").
  154.  
  155.  
  156.  
  157.                                    - Page 3 -
  158.             Blue Wave Mail Packet File Structures - Revision Level 2
  159.  
  160.  
  161.      FILES IN BLUE WAVE PACKETS
  162.      ==========================
  163.  
  164.      There  are two main components to the Blue Wave system: mail  packets,
  165.      which  consist  of messages obtained from the host system (such  as  a
  166.      BBS), and reply packets, which consist of messages written by the user
  167.      via  an offline mail reader (such as the reader that bears  its  name,
  168.      the Blue Wave Offline Mail Reader).  Each type of packet contains  its
  169.      own set of unique files.
  170.  
  171.      Blue  Wave  mail and reply packet filenames are based around  what  is
  172.      called  a  "packet  ID".  The packet ID is a one  to  eight  character
  173.      string that uniquely identifies a particular host system, and is  used
  174.